Exploring the DX API with Postman

1. In the Pega instance for the challenge, enter the following credentials:
   1. In the User name field, enter Author@SL.
   2. In the Password field, enter pega123!
2. Switch to Dev Studio.
3. In the header of Dev Studio, click Configure > Org & Security > Organization > Operators.
4. In the list of operators, open the TellUsMore_Service operator.
   
5. Click the Security tab.
6. Click Update password, and then update the password to pega123!.
7. Confirm that the selection for the Force password change on next login check box is clear.
   
8. Click Save.

1. In the navigation pane of Dev Studio, click Records > Security > OAuth 2.0 Client Registration.
2. In the upper-right corner of the OAuth 2.0 Client Registration list, click Create.
3. In both the OAuth 2.0 Client Registration short description and Client name fields, enter Sweet Life DX API Test.
   
4. Click Create and open.
5. Configure the record:
   1. In the Supported grant types section, clear the Client credentials checkbox, and then select the Password credentials checkbox.
   2. In the Identity mapping field, press the Down arrow key, and then select pyDefaultIdentityMappingForPasswordGrant.
   3. Select the Enable refresh token checkbox.
      
   4. In the Client Credentials section, click View & download.
      
   5. In the View & download window, click Download credentials.
      
   6. Confirm that you downloaded the Sweet Life DX API TEst_Client Credentials file on your machine.
   7. Close the View & download window.
   8. In the header of the record, click Save.
      Note: After you save the record, the option to download the credentials is inactive.

1. In the App Explorer, in the SL-TellUsMore-Work-Incident class, right-click Data Model, and then select Create > Data Transform. 
2. In the Label field, enter AllowedStartingFields.
3. Click Create and open.
4. In the Data Transform, set the .pyDescription target equal to "".
   
   Note: You can add additional fields to the AllowedStartingFields Data Transform. For more information about adding fields while creating Cases in DX API v2, see Adding fields while creating Cases in Constellation DX API.
5. Click Save.

1. Download the DXAPIdefinition.postman_collection.zip file to your machine, and then open and extract it:
   DXAPIdefinition.postman_collection.zip (72.08 KB)
2. Extract the file from Step 1, and then save the DXAPIdefinition.postman_collection.json file to your machine.
3. Access the Postman website, and then create a free account if you do not have one already.
4. Create a workspace named Sweet Life DX API Test for this challenge.
   
5. In the workspace, click Import, and then import  DXAPIdefinition.postman_collection.json file.
   The import beings automatically when you select the file.
   
6. On the DX API definition, click the Variables tab.
   
7. Open the Sweet Life DX API Test_ClientCredentials.txt file that you downloaded and saved in an earlier task. 
8. Modify the values in the Current value column so that they correspond to the information contained in the Sweet Life DX API Test_ClientCredentials (SLDXAPI_CC) file.
   You must modify some information from the SLDXAPI_CC file slightly. The following table includes more information: 

   Postman variable name	Current value
   server	Enter a partial URL from the SLDXAPI_CC file that includes the text from https to prweb. For example, https://*******.pegacea.net/prweb. The asterisks correspond to server-specific values in your SLDXAPI_CC file.
   baseUrl	Enter a partial URL from the SLDXAPI_CC file that includes the text from https to prweb, and then append /api/application/v2. For example, https://*******.pegacea.net/prweb/api/applications/v2. The asterisks correspond to server-specific values in your SLDXAPI_CC file.
   AccessTokenURL	Enter the Access token endpoint value from the SLDXAPI_CC file
   ClientID	Enter the Client ID from the SLDXAPI_CC file
   ClientSecret	Enter the Client Secret from the SLDXAPI_CC file
   user	TellUsMore_Service
   password	pega123!
   OriginChannel	Web

9. Click Save.
   
10. Click Save.
11. Click the Authorization tab, and then review the details:
    1. Confirm that value in the Type list is OAuth 2.0.
    2. Confirm that that value in the Token list is Available tokens.
       
12. In the Configure New Token section, view the value in the Password field, and then confirm the value is {{password}}.
    
13. Click Save if you have made updates.
14. On the Authorization tab, attempt to generate a new token and verify that the authentication configuration is successful by clicking Get New Access Token.
    After Postman authorizes the information you entered, a screen with your new access token is displayed.
15. Click Use Token to save the new token to your authorization profile.
    

Postman updates the token associated with the authorization profile.

1. In the navigation pane of Postman, expand the cases folder, and then click Create new Incident - success.
   
2. Click the Body tab, and then enter the following JSON code:
   {
       "content": {
            "pyDescription": "Description"
       },
       "caseTypeID": "SL-TellUsMore-Work-Incident",
       "parentCaseID": ""
   }
3. Click Send to send the DX API request.
   
4. Toward the bottom of the request page, view the JSON response object that Postman returned, noting the pyID value for the newly created Case.
   
5. Analyze the JSON response data objects returned by the DX API:
   1. Review the caseInfo object.
      
   2. Review the relatedCaseTypes object.
      
   3. The assignments object.
      The assignments object in the API response provides information about the Assignments created as part of the Case. It can include details such as the Assignment ID, the name of the assignee, the deadline for completion, and any associated data or attachments.
      
   4. Review the availableChildCaseTypes object.
      
   5. Review the availableActions object.
      The availableActions object that returns in the response of Create DX API is a list of Actions that users can perform on the created work object. These Actions are defined in the Case Type and can include options such as submitting the work object, saving it as a draft, or canceling it.
      
   6. Review the stages section: 
      In Pega DX API, the stages object in the response for Case creation refers to the Stage of the Case where the newly created Case currently resides. A Stage in Pega Platform™ represents a logical division of a Case where a specific set of Actions or Tasks are performed. Each Stage typically has a set of Steps or Assignments that must be completed before the Case can move on to the next Stage. When you create a Case with the Pega DX API, the response includes a Stage object that provides information about the current Stage of the Case. This object might include properties such as the Stage name, ID, status, and other details about the current Stage. This information can be useful for tracking the progress of the Case and determining what Tasks or Assignments need to be completed before the Case can move on to the next Stage.
      
6. In the nextAssignmentInfo object, copy the Assignment ID returned by the DX API (for example, ASSIGN-WORKLIST SL-TELLUSMORE-WORK I-1!CREATEFORM_DEFAULT) for the next task.
   
7. Return to App Studio, preview the application, and then open the TellUsMore - BO Portal.
8. Click Incidents, and then confirm that the newly created Case is displayed on the landing page.
   

1. In the navigation pane of Postman, expand the assignments > {assignmentsID} folder path.
2. Open the Get first assignment details request.
   
3. In the central work pane, click the Params tab, and then modify the query param values:
   1. In the viewType row, enter page.
   2. Leave the pageName row empty.
   3. In the assignmentID row, enter the value returned in the nextAssignment object from the new Case call that you copied in Task 5, step 6.
      For example, ASSIGN-WORKLIST SL-TELLUSMORE-WORK I-1!CREATEFORM_DEFAULT.
      
4. Click Save, and then click Send.
5. Investigate the JSON response object, and then copy the details of the submit object for the next task (for example, ASSIGN-WORKLIST SL-TELLUSMORE-WORK I-1!CREATEFORM_DEFAULT).
   

1. In the navigation pane of Postman, expand the assignments > actions > {actionID} folder path.
2. Open the Get submit action details request.
   
3. In the central work pane, click the Params tab, and then modify the query param values:
   1. Leave the viewType row empty.
   2. In the excludeAdditionalActions row, enter true.
   3. In the assignmentID row, enter the value from the submit object from Task 6, step 5 (for example, ASSIGN-WORKLIST SL-TELLUSMORE-WORK I-1!CREATEFORM_DEFAULT).
   4. In the actionID row, enter DetermineCategory.
      
4. Click Save, and then click Send.
5. Review the JSON response object.
6. In the response, click the Headers tab, and then copy the etag value for the next task.
   

1. In the navigation pane of Postman, expand the assignments > {assignmentID} > actions > {actionID} folder path.
2. Open the Submit first assignment request file.
   
3. In the central work pane, open the Params tab, and then modify the query param values:
   1. In the viewType row, enter none.
   2. In the assignmentID row, enter the value from the submit object that you copied in Task 5, step 6. (for example, ASSIGN-WORKLIST SL-TELLUSMORE-WORK I-1!CREATEFORM_DEFAULT).
   3. In the actionID row, enter DetermineCategory.
      
4. Click the Headers tab, and then in the if match row, enter the value from the etag object that you copied in Task 6, step 6.
   
5. Click the Body tab, and then enter the following JSON request code:
   {
       "content": {
           "IncidentType": "Product faulty or unsafe",
           "IncidentSubType": "Product not as described"
       }
   }
6. Click Save, and then click Send.
7. Review the JSON response object, and then confirm that the request was successful.
   
8. Return to App Studio, preview the application, and then open the TellUsMore - BO Portal.
9. Confirm that the Incidents landing page contains values the Incident Type and Incident SubType fields.